Authentication Service

TpAuthentication

The authentication object has to be send with every method whenever a user-authentication is required. This ensures that the user has the required access rights.

Datatype	Name	Description
String	CustomerToken	Defines the mandated customer. This field correlates to the database settings in the TimePunch Server
String	TpUser	TimePunch Profile of the used Principal
String	TpHashedPwd	Password Hash (build with MD5 Encryption)
String	Identity	Profile Name of the used Identity, or empty, if the identity is equal to the principal. In order to switch the identity, the principal needs administration rights.
String	Culture	Culture that is used for the localization. e.g. „de-DE”

ValidatedAuthenticationDto : TpAuthentication

This class is returned at logon and contains the permissions and the filled customer token in addition to the transferred data of the TpAuthentication class.

Datatype	Name	Description
List<String>	ValidatedPermissions	Permissions of the logged on user.
String	OpenIdProvider	The connected OAuth2/OpenId Provider
Guid	UserId	The unique Id of the TimePunch user

UserProfileDto

Diese Klasse enthält die Basisdaten um ein TimePunch Profil zu identifizieren.

Datatype	Name	Description
Guid	Id	Unique ID of TimePunch Profile
String	SaveAsName	Name of the TimePunch Profile used to show the user.
String	LogonName	By default the logon name is identical to the used windows logon.
String	UserName	First name and last name of the user.
String	Email	Email of the user

UserLogonDto : UserProfileDto

This class is derived from the UserProfileDto and contains the base data and in addition a TimePunch profile to identify expanded information.

Datatype	Name	Description
UserRights	Rights	Permission of the user
DateTime?	FirstEntry	Date/Time of the first entry, if the user has an entry, otherwise NULL
DateTime?	LastEntry	Date/Time of the last entry, if the user has an entry, otherwise NULL
Bool	IsUserProfileActive	True, if the user profile is active.
DateTime?	LockedUpTo	Date until that the time entries are locked. NULL, if no time entries are locked at all.
Bool	IsInCoverage	True, if the user profile is in coverage
String	OAuth2Provider	The connected OAuth2 Provider

UserSearchDto : PagingContextDto

This class contains all basic data of PagingContextDto and defines a filter to search for TimePunch profiles.

Datatype	Name	Description
UserFiltering	UserFiltering	Defines if the users are filtered (CurrentUser, AllUser, SelfDefined)
Guid[]	UserIds	If Filter is set to “SelfDefined” than the users will be filtered by the given ids.
String	GenericSearch	Generic search string that search for logon and/or user name.
Bool?	IsUserDeleted	NULL, searches for deleted and active users. True, to search only for deleted users. False, to search only for non-deleted users.
Guid[]	IsNotInGroupIds	List of group Ids where the user may not be a member of
Guid[]	IsInGroupIds	List of group Ids where the user must be a member of
string	LogonName	Searches for the logon name
string	UserCode	Searches for the user code
Bool	ApplyUserCoverage	Applies the coverage for the search

AutoregistrationDto

This class contains information about whether automatic registration of new employees is allowed.

Datatype	Name	Description
Bool	IsAutoregistrationAllowed	Defines whether the auto-registration of new staff members is allowed.
UserRights	DefaultUserRights	Get the user rights of new staff members
Bool	IsAutomaticLicensing	Defines whether new members will get a new license. But only if there are licenses still available.
ProxySettings	ProxySettings	Defines the proxy settings of the server that also applies to the client.
Bool	TryToAuthenticationWithLocalAD	True, if the client shall try to authenticate with local Active Directory settings

ProxySettings

This class contains the proxy information for the clients. The proxy configuration can be set in the client settings.

Datatype	Name	Description
Bool	UseProxy	Indicates if a proxy should be used
Bool	UseProxyAuthentication	Indicates if proxy authentication is required
Bool	BypassProxyOnLocal	Indicates if the proxy should be bypassed for local addresses
String	ProxyUser	The username for proxy authentication
String	ProxyPassword	The password for proxy authentication
String	ProxyServer	The address of the proxy server
Integer	ProxyPort	The port number of the proxy server